Docs For Class Payment_Data

Description

Class for saving data which is necessary for different payment systems and implementation of standard operations with them. Also it contains information about the operating modes of the class functioning.

Located in /include/Payment_Data_Kipper.php (line 13)

Direct descendents

Class	Description
Payment_authorizenet	Authorizenet payment system class
Payment_barclays	Barclays payment system class
Payment_ccbill	ccbill payment system class
Payment_chronopay	ChronoPay payment system class
Payment_egold	e-gold payment system class
Payment_esec	Esec payment system class
Payment_ipos	iPOS payment system class
Payment_ogone	Ogone payment system class
Payment_paypal	paypal payment system class
Payment_paysat	PaySat payment system class
Payment_usaepay	usaepay payment system class
Payment_webmoney	webmoney payment system class
Payment_worldpay	worldpay payment system class

Variable Summary

mixed $_debug

mixed $_method

mixed $_optional

mixed $_options

mixed $_required

Method Summary

Payment_Data_Kipper Payment_Data_Kipper ()

bool fieldExist (mixed $field)

mixed formMessage ()

mixed getField (string $field)

array getFields ()

void isRequired (string $field)

void makeFields ()

void makeOptional (... 0)

void makeOptionalField (string $field, [string $value = null])

void makeRequired (... 0)

void makeRequiredField (string $field, [string $value = null])

bool set (mixed $field, mixed $value)

void setFrom (array $where)

Variables

mixed $_debug = false (line 21)

Debug mode

access: protected

mixed $_method = PAYMENT_ENGINE_SEND (line 29)

Mode of class operation PAYMENT_ENGINE_SEND or PAYMENT_ENGINE_RECEIVE

access: protected

mixed $_optional = array() (line 69)

The list of optional parameters

access: protected

mixed $_options = array() (line 53)

Array of the data with parameters

access: protected

mixed $_required = array() (line 61)

The list of obligatory parameters

access: protected

Methods

Constructor Payment_Data_Kipper (line 74)

Standard constructor

Payment_Data_Kipper Payment_Data_Kipper ()

fieldExist (line 109)

Check for some parameters existence.

access: protected

bool fieldExist (mixed $field)

formMessage (line 234)

Creation of a form or a string of a request by some definite method depending on the settings of a definite class of a payment system.

access: protected

mixed formMessage ()

getField (line 96)

Returns the value of the parameter by key.

return: returns the value of string if the field exists, otherwise false will be returned
access: public

mixed getField (string $field)

string $field: Èìÿ ïàðàìåòðà

getFields (line 84)

Retrun the list of parameters.

access: protected

array getFields ()

isRequired (line 208)

Check whether the parameter is obligatory or not

access: protected

void isRequired (string $field)

string $field: the name of the parameter used for checking

makeFields (line 171)

Combines obligatory and optional parameters into one list.

access: protected

void makeFields ()

makeOptional (line 160)

Sets the parameters optional.

access: protected

void makeOptional (... 0)

... 0: Parameters enumeration

makeOptionalField (line 198)

Adds optional parameter.

access: public

void makeOptionalField (string $field, [string $value = null])

string $field: Name of the parameter
string $value: Value of the parameter

makeRequired (line 148)

Sets the parameters obligatory.

access: protected

void makeRequired (... 0)

... 0: Parameters enumeration

makeRequiredField (line 187)

Adds obligatory parameter.

access: public

void makeRequiredField (string $field, [string $value = null])

string $field: Name of the parameter
string $value: Value of the parameter

set (line 134)

Setup of a definite value to a definite parameter. It is necessary for the parameter to already exist.

return: will return true if the field exists, otherwise false will be returned
access: public

bool set (mixed $field, mixed $value)

setFrom (line 119)

Settings setup from an array. It is necessary for the parameter to already exist.

void setFrom (array $where)

array $where: assotiative array 'key' => 'value'

Class Payment_Data_Kipper